- Cloudmersive Documentation

Node.JS Python C# Java PHP Objective-C Ruby Apex C/C++ cURL Swift JavaScript Go

Run this command to install the SDK:

npm install cloudmersive-convert-api-client --save

Or add this snippet to your package.json:

  "dependencies": {
    "cloudmersive-convert-api-client": "^2.6.3"
  }

var CloudmersiveConvertApiClient = require('cloudmersive-convert-api-client');
var defaultClient = CloudmersiveConvertApiClient.ApiClient.instance;

// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';



var apiInstance = new CloudmersiveConvertApiClient.EditDocumentApi();

var input = new CloudmersiveConvertApiClient.DocxSetCustomMetadataPropertiesRequest(); // DocxSetCustomMetadataPropertiesRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.editDocumentDocxSetCustomMetadataProperties(input, callback);

Run this command to install the SDK:

pip install cloudmersive-convert-api-client

from __future__ import print_function
import time
import cloudmersive_convert_api_client
from cloudmersive_convert_api_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: Apikey
configuration = cloudmersive_convert_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'



# create an instance of the API class
api_instance = cloudmersive_convert_api_client.EditDocumentApi(cloudmersive_convert_api_client.ApiClient(configuration))
input = cloudmersive_convert_api_client.DocxSetCustomMetadataPropertiesRequest() # DocxSetCustomMetadataPropertiesRequest | 

try:
    # Set custom property metadata properties in Word DOCX document
    api_response = api_instance.edit_document_docx_set_custom_metadata_properties(input)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling EditDocumentApi->edit_document_docx_set_custom_metadata_properties: %s\n" % e)

.NET Framework | .NET Core

Run this command to install the SDK:

Install-Package Cloudmersive.APIClient.NET.DocumentAndDataConvert -Version 3.4.2

using System;
using System.Diagnostics;
using Cloudmersive.APIClient.NET.DocumentAndDataConvert.Api;
using Cloudmersive.APIClient.NET.DocumentAndDataConvert.Client;
using Cloudmersive.APIClient.NET.DocumentAndDataConvert.Model;

namespace Example
{
    public class EditDocumentDocxSetCustomMetadataPropertiesExample
    {
        public void main()
        {
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            
            

            var apiInstance = new EditDocumentApi();
            var input = new DocxSetCustomMetadataPropertiesRequest(); // DocxSetCustomMetadataPropertiesRequest | 

            try
            {
                // Set custom property metadata properties in Word DOCX document
                byte[] result = apiInstance.EditDocumentDocxSetCustomMetadataProperties(input);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EditDocumentApi.EditDocumentDocxSetCustomMetadataProperties: " + e.Message );
            }
        }
    }
}

using System;
using System.Diagnostics;
using Cloudmersive.APIClient.NETCore.DocumentAndDataConvert.Api;
using Cloudmersive.APIClient.NETCore.DocumentAndDataConvert.Client;
using Cloudmersive.APIClient.NETCore.DocumentAndDataConvert.Model;

namespace Example
{
    public class EditDocumentDocxSetCustomMetadataPropertiesExample
    {
        public void main()
        {
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            
            

            var apiInstance = new EditDocumentApi();
            var input = new DocxSetCustomMetadataPropertiesRequest(); // DocxSetCustomMetadataPropertiesRequest | 

            try
            {
                // Set custom property metadata properties in Word DOCX document
                byte[] result = apiInstance.EditDocumentDocxSetCustomMetadataProperties(input);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EditDocumentApi.EditDocumentDocxSetCustomMetadataProperties: " + e.Message );
            }
        }
    }
}

To install with Maven, add a reference to the repository in pom.xml:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

And add a reference to the dependency in pom.xml:

<dependencies>
<dependency>
    <groupId>com.github.Cloudmersive</groupId>
    <artifactId>Cloudmersive.APIClient.Java</artifactId>
    <version>v4.25</version>
</dependency>
</dependencies>

To install with Gradle, add it in your root build.gradle at the end of repositories:

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

And add the dependency in build.gradle:

dependencies {
        implementation 'com.github.Cloudmersive:Cloudmersive.APIClient.Java:v4.25'
}

// Import classes:
//import com.cloudmersive.client.invoker.ApiClient;
//import com.cloudmersive.client.invoker.ApiException;
//import com.cloudmersive.client.invoker.Configuration;
//import com.cloudmersive.client.invoker.auth.*;
//import com.cloudmersive.client.EditDocumentApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: Apikey
ApiKeyAuth Apikey = (ApiKeyAuth) defaultClient.getAuthentication("Apikey");
Apikey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.setApiKeyPrefix("Token");

EditDocumentApi apiInstance = new EditDocumentApi();
DocxSetCustomMetadataPropertiesRequest input = new DocxSetCustomMetadataPropertiesRequest(); // DocxSetCustomMetadataPropertiesRequest | 
try {
    byte[] result = apiInstance.editDocumentDocxSetCustomMetadataProperties(input);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EditDocumentApi#editDocumentDocxSetCustomMetadataProperties");
    e.printStackTrace();
}

Run this command to install the SDK:

composer require cloudmersive/cloudmersive_document_convert_api_client

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: Apikey
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Apikey', 'YOUR_API_KEY');



$apiInstance = new Swagger\Client\Api\EditDocumentApi(
    
    
    new GuzzleHttp\Client(),
    $config
);
$input = new \Swagger\Client\Model\DocxSetCustomMetadataPropertiesRequest(); // \Swagger\Client\Model\DocxSetCustomMetadataPropertiesRequest | 

try {
    $result = $apiInstance->editDocumentDocxSetCustomMetadataProperties($input);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EditDocumentApi->editDocumentDocxSetCustomMetadataProperties: ', $e->getMessage(), PHP_EOL;
}
?>

Add the Objective-C client to your Podfile:

pod 'CloudmersiveDocumentAndDataConvertApiClient', '~> 1.0'

CMDefaultConfiguration *apiConfig = [CMDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: Apikey)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Apikey"];




CMDocxSetCustomMetadataPropertiesRequest* input = [[CMDocxSetCustomMetadataPropertiesRequest alloc] init]; // 

CMEditDocumentApi*apiInstance = [[CMEditDocumentApi alloc] init];

// Set custom property metadata properties in Word DOCX document
[apiInstance editDocumentDocxSetCustomMetadataPropertiesWithInput:input
          completionHandler: ^(NSData* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling CMEditDocumentApi->editDocumentDocxSetCustomMetadataProperties: %@", error);
                        }
                    }];

Add the Ruby client to your Gemfile:

gem 'cloudmersive-convert-api-client', '~> 2.1.6'

# load the gem
require 'cloudmersive-convert-api-client'
# setup authorization
CloudmersiveConvertApiClient.configure do |config|
  # Configure API key authorization: Apikey
  config.api_key['Apikey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Apikey'] = 'Bearer'
end

api_instance = CloudmersiveConvertApiClient::EditDocumentApi.new

input = CloudmersiveConvertApiClient::DocxSetCustomMetadataPropertiesRequest.new # DocxSetCustomMetadataPropertiesRequest | 


begin
  #Set custom property metadata properties in Word DOCX document
  result = api_instance.edit_document_docx_set_custom_metadata_properties(input)
  p result
rescue CloudmersiveConvertApiClient::ApiError => e
  puts "Exception when calling EditDocumentApi->edit_document_docx_set_custom_metadata_properties: #{e}"
end

Download and copy the /client folder into your Apex project:

Download Apex Client

SwagEditDocumentApi api = new SwagEditDocumentApi();
SwagClient client = api.getClient();

// Configure API key authorization: Apikey
ApiKeyAuth Apikey = (ApiKeyAuth) client.getAuthentication('Apikey');
Apikey.setApiKey('YOUR API KEY');

Map<String, Object> params = new Map<String, Object>{
    'input' => SwagDocxSetCustomMetadataPropertiesR.getExample()
};

try {
    // cross your fingers
    Blob result = api.editDocumentDocxSetCustomMetadataProperties(params);
    System.debug(result);
} catch (Swagger.ApiException e) {
    // ...handle your exceptions
}

Install libcurl in your C/C++ project:

libcurl/7.75.0

CURL *curl;
CURLcode res;
curl = curl_easy_init();
if(curl) {
     curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
     curl_easy_setopt(curl, CURLOPT_URL, "https://api.cloudmersive.com/convert/edit/docx/set-metadata/custom-property");
     curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
     curl_easy_setopt(curl, CURLOPT_DEFAULT_PROTOCOL, "https");
     struct curl_slist *headers = NULL;
     headers = curl_slist_append(headers, "Content-Type: application/x-www-form-urlencoded");
     headers = curl_slist_append(headers, "Apikey: YOUR-API-KEY-HERE");
     curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
     const char *data = "InputFileBytes=%3Cbyte%3E&InputFileUrl=%3Cstring%3E&PropertiesToSet=%7B%22PropertyName%22%3A%22Ut%20Lorem%22%2C%22PropertyDataType%22%3A%22officia%20fugiat%20consectetur%20nostrud%20nulla%22%2C%22StringValue%22%3A%22eu%20ullamco%22%2C%22IntegerValue%22%3A68249239%2C%22DoubleValue%22%3A-74317056.61724073%2C%22DateValue%22%3A%222010-01-05T07%3A08%3A13.898Z%22%7D&PropertiesToSet=%7B%22PropertyName%22%3A%22tempor%20anim%20%22%2C%22PropertyDataType%22%3A%22esse%20eiusmod%20Lorem%22%2C%22StringValue%22%3A%22nisi%20et%20voluptate%20laborum%22%2C%22IntegerValue%22%3A48278423%2C%22DoubleValue%22%3A3021945.091744721%2C%22DateValue%22%3A%221974-11-22T10%3A18%3A58.649Z%22%7D";
     curl_easy_setopt(curl, CURLOPT_POSTFIELDS, data);
     res = curl_easy_perform(curl);
}
curl_easy_cleanup(curl);

curl --location --request POST 'https://api.cloudmersive.com/convert/edit/docx/set-metadata/custom-property' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Apikey: YOUR-API-KEY-HERE' \
--data-urlencode 'InputFileBytes=<byte>' \
--data-urlencode 'InputFileUrl=<string>' \
--data-urlencode 'PropertiesToSet={"PropertyName":"occaecat dolore ut","PropertyDataType":"aute Lorem magna esse in","StringValue":"Lorem nostrud","IntegerValue":7776993,"DoubleValue":96831313.72365668,"DateValue":"1990-06-30T13:54:29.661Z"}' \
--data-urlencode 'PropertiesToSet={"PropertyName":"","PropertyDataType":"occaecat pariatur dolore non","StringValue":"in qui","IntegerValue":76453694,"DoubleValue":-72999476.54638737,"DateValue":"1964-03-02T15:27:41.303Z"}'

import Foundation
#if canImport(FoundationNetworking)
import FoundationNetworking
#endif

var semaphore = DispatchSemaphore (value: 0)

let parameters = "InputFileBytes=%3Cbyte%3E&InputFileUrl=%3Cstring%3E&PropertiesToSet=%7B%22PropertyName%22%3A%22consectetur%20sit%22%2C%22PropertyDataType%22%3A%22est%20officia%20consectetur%20in%22%2C%22StringValue%22%3A%22dolor%20est%20officia%22%2C%22IntegerValue%22%3A-78476156%2C%22DoubleValue%22%3A59789948.1113171%2C%22DateValue%22%3A%222010-04-07T17%3A15%3A43.923Z%22%7D&PropertiesToSet=%7B%22PropertyName%22%3A%22qui%20in%20aute%22%2C%22PropertyDataType%22%3A%22est%20dolor%20magna%22%2C%22StringValue%22%3A%22do%20anim%20in%20officia%22%2C%22IntegerValue%22%3A90665952%2C%22DoubleValue%22%3A12836325.786376476%2C%22DateValue%22%3A%222009-12-10T21%3A00%3A10.277Z%22%7D"
let postData =  parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "https://api.cloudmersive.com/convert/edit/docx/set-metadata/custom-property")!,timeoutInterval: Double.infinity)
request.addValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type")
request.addValue("YOUR-API-KEY-HERE", forHTTPHeaderField: "Apikey")

request.httpMethod = "POST"
request.httpBody = postData

let task = URLSession.shared.dataTask(with: request) { data, response, error in 
     guard let data = data else {
          print(String(describing: error))
          semaphore.signal()
          return
     }
     print(String(data: data, encoding: .utf8)!)
     semaphore.signal()
}

task.resume()
semaphore.wait()

XHR | jQuery

This code snippet uses the built-in JavaScript XHR request capability

var data = "InputFileBytes=%3Cbyte%3E&InputFileUrl=%3Cstring%3E&PropertiesToSet=%7B%22PropertyName%22%3A%22cillum%20ut%20ipsum%20laboris%20sint%22%2C%22PropertyDataType%22%3A%22magna%20dolor%20aliqua%22%2C%22StringValue%22%3A%22ut%22%2C%22IntegerValue%22%3A-13264092%2C%22DoubleValue%22%3A-33896026.8854001%2C%22DateValue%22%3A%222014-07-31T01%3A58%3A40.870Z%22%7D&PropertiesToSet=%7B%22PropertyName%22%3A%22fugiat%20amet%22%2C%22PropertyDataType%22%3A%22dolore%20veniam%20incididunt%20laborum%20enim%22%2C%22StringValue%22%3A%22in%20laboris%20velit%22%2C%22IntegerValue%22%3A6976227%2C%22DoubleValue%22%3A-97362607.92499655%2C%22DateValue%22%3A%221977-01-06T23%3A04%3A05.312Z%22%7D";

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function() {
     if(this.readyState === 4) {
          console.log(this.responseText);
     }
});

xhr.open("POST", "https://api.cloudmersive.com/convert/edit/docx/set-metadata/custom-property");
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.setRequestHeader("Apikey", "YOUR-API-KEY-HERE");

xhr.send(data);

var settings = {
     "url": "https://api.cloudmersive.com/convert/edit/docx/set-metadata/custom-property",
     "method": "POST",
     "timeout": 0,
     "headers": {
          "Content-Type": "application/x-www-form-urlencoded",
          "Apikey": "YOUR-API-KEY-HERE"
     },
     "data": {
          "InputFileBytes": "<byte>",
          "InputFileUrl": "<string>",
          "PropertiesToSet": "{\"PropertyName\":\"ut ut sunt aute\",\"PropertyDataType\":\"reprehenderit anim\",\"StringValue\":\"officia aliqua\",\"IntegerValue\":70629533,\"DoubleValue\":-32148024.00897056,\"DateValue\":\"1973-05-21T12:50:49.389Z\"}",
          "PropertiesToSet": "{\"PropertyName\":\"nostrud \",\"PropertyDataType\":\"in non nulla\",\"StringValue\":\"commodo adipisicing Ut labore\",\"IntegerValue\":57541220,\"DoubleValue\":69189595.23358265,\"DateValue\":\"2001-01-08T15:32:01.842Z\"}"
     }
};

$.ajax(settings).done(function (response) {
     console.log(response);
});

package main

import (
     "fmt"
     "strings"
     "net/http"
     "io/ioutil"
)

func main() {

     url := "https://api.cloudmersive.com/convert/edit/docx/set-metadata/custom-property"
     method := "POST"

     payload := strings.NewReader("InputFileBytes=%3Cbyte%3E&InputFileUrl=%3Cstring%3E&PropertiesToSet=%7B%22PropertyName%22%3A%22nostrud%20amet%20id%22%2C%22PropertyDataType%22%3A%22velit%20veniam%20voluptate%20aliq%22%2C%22StringValue%22%3A%22fugiat%20incididunt%20commodo%20et%22%2C%22IntegerValue%22%3A-91987211%2C%22DoubleValue%22%3A-73534189.23134512%2C%22DateValue%22%3A%222010-06-02T02%3A54%3A36.731Z%22%7D&PropertiesToSet=%7B%22PropertyName%22%3A%22tempor%20nulla%20ipsum%20reprehenderit%20magna%22%2C%22PropertyDataType%22%3A%22in%20ex%22%2C%22StringValue%22%3A%22est%20anim%20sunt%20sint%22%2C%22IntegerValue%22%3A96870771%2C%22DoubleValue%22%3A76077734.23702651%2C%22DateValue%22%3A%221996-08-09T15%3A43%3A36.658Z%22%7D")

     client := &http.Client {
     }
     req, err := http.NewRequest(method, url, payload)

     if err != nil {
          fmt.Println(err)
          return
     }
     req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
     req.Header.Add("Apikey", "YOUR-API-KEY-HERE")

     res, err := client.Do(req)
     if err != nil {
          fmt.Println(err)
          return
     }
     defer res.Body.Close()

     body, err := ioutil.ReadAll(res.Body)
     if err != nil {
          fmt.Println(err)
          return
     }
     fmt.Println(string(body))
}

Walkthrough Video